@aws-sdk/client-securityhub
Description
AWS SDK for JavaScript SecurityHub Client for Node.js, Browser and React Native.
Security Hub provides you with a comprehensive view of your security state in Amazon Web Services and helps
you assess your Amazon Web Services environment against security industry standards and best practices.
Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services services, and
supported third-party products and helps you analyze your security trends and identify the highest priority security
issues.
To help you manage the security state of your organization, Security Hub supports multiple security standards.
These include the Amazon Web Services Foundational Security Best Practices (FSBP) standard developed by Amazon Web Services,
and external compliance frameworks such as the Center for Internet Security (CIS), the Payment Card Industry Data
Security Standard (PCI DSS), and the National Institute of Standards and Technology (NIST). Each standard includes
several security controls, each of which represents a security best practice. Security Hub runs checks against
security controls and generates control findings to help you assess your compliance against security best practices.
In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services services,
such as Amazon GuardDuty and Amazon Inspector, and
supported third-party products. This gives you a single pane of glass into a variety of security-related issues. You
can also send Security Hub findings to other Amazon Web Services services and supported third-party products.
Security Hub offers automation features that help you triage and remediate security issues. For example,
you can use automation rules to automatically update critical findings when a security check fails. You can also leverage the integration with
Amazon EventBridge to trigger automatic responses to specific findings.
This guide, the Security Hub API Reference, provides
information about the Security Hub API. This includes supported resources, HTTP methods, parameters,
and schemas. If you're new to Security Hub, you might find it helpful to also review the
Security Hub User Guide
. The
user guide explains key concepts and provides procedures
that demonstrate how to use Security Hub features. It also provides information about topics such as
integrating Security Hub with other Amazon Web Services services.
In addition to interacting with Security Hub by making calls to the Security Hub API, you can
use a current version of an Amazon Web Services command line tool or SDK. Amazon Web Services provides tools
and SDKs that consist of libraries and sample code for various languages and platforms, such as PowerShell,
Java, Go, Python, C++, and .NET. These tools and SDKs provide convenient, programmatic access to
Security Hub and other Amazon Web Services services . They also handle tasks such as signing requests,
managing errors, and retrying requests automatically. For information about installing and using the Amazon Web Services tools
and SDKs, see Tools to Build on Amazon Web Services.
With the exception of operations that are related to central configuration, Security Hub API requests are executed only in
the Amazon Web Services Region that is currently active or in the specific Amazon Web Services Region that you specify in your request. Any configuration or settings change
that results from the operation is applied only to that Region. To make the same change in
other Regions, call the same API operation in each Region in which you want to apply the change. When you use central configuration,
API requests for enabling Security Hub, standards, and controls are executed in the home Region and all linked Regions. For a list of
central configuration operations, see the Central configuration
terms and concepts section of the Security Hub User Guide.
The following throttling limits apply to Security Hub API operations.
-
BatchEnableStandards
- RateLimit
of 1 request per
second. BurstLimit
of 1 request per second.
-
GetFindings
- RateLimit
of 3 requests per second.
BurstLimit
of 6 requests per second.
-
BatchImportFindings
- RateLimit
of 10 requests per second.
BurstLimit
of 30 requests per second.
-
BatchUpdateFindings
- RateLimit
of 10 requests per second.
BurstLimit
of 30 requests per second.
-
UpdateStandardsControl
- RateLimit
of 1 request per
second. BurstLimit
of 5 requests per second.
-
All other operations - RateLimit
of 10 requests per second.
BurstLimit
of 30 requests per second.
Installing
To install this package, simply type add or install @aws-sdk/client-securityhub
using your favorite package manager:
npm install @aws-sdk/client-securityhub
yarn add @aws-sdk/client-securityhub
pnpm add @aws-sdk/client-securityhub
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the SecurityHubClient
and
the commands you need, for example ListMembersCommand
:
const { SecurityHubClient, ListMembersCommand } = require("@aws-sdk/client-securityhub");
import { SecurityHubClient, ListMembersCommand } from "@aws-sdk/client-securityhub";
Usage
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call
send
operation on client with command object as input. - If you are using a custom http handler, you may call
destroy()
to close open connections.
const client = new SecurityHubClient({ region: "REGION" });
const params = {
};
const command = new ListMembersCommand(params);
Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} finally {
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.
Promises
You can also use Promise chaining
to execute send operation.
client.send(command).then(
(data) => {
},
(error) => {
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
client.send(command, (err, data) => {
});
v2 compatible style
The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-securityhub";
const client = new AWS.SecurityHub({ region: "REGION" });
try {
const data = await client.listMembers(params);
} catch (error) {
}
client
.listMembers(params)
.then((data) => {
})
.catch((error) => {
});
client.listMembers(params, (err, data) => {
});
Troubleshooting
When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
Getting Help
Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.
Contributing
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-securityhub
package is updated.
To contribute to client you can check our generate clients scripts.
License
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
Client Commands (Operations List)
AcceptAdministratorInvitation
Command API Reference / Input / Output
AcceptInvitation
Command API Reference / Input / Output
BatchDeleteAutomationRules
Command API Reference / Input / Output
BatchDisableStandards
Command API Reference / Input / Output
BatchEnableStandards
Command API Reference / Input / Output
BatchGetAutomationRules
Command API Reference / Input / Output
BatchGetConfigurationPolicyAssociations
Command API Reference / Input / Output
BatchGetSecurityControls
Command API Reference / Input / Output
BatchGetStandardsControlAssociations
Command API Reference / Input / Output
BatchImportFindings
Command API Reference / Input / Output
BatchUpdateAutomationRules
Command API Reference / Input / Output
BatchUpdateFindings
Command API Reference / Input / Output
BatchUpdateStandardsControlAssociations
Command API Reference / Input / Output
CreateActionTarget
Command API Reference / Input / Output
CreateAutomationRule
Command API Reference / Input / Output
CreateConfigurationPolicy
Command API Reference / Input / Output
CreateFindingAggregator
Command API Reference / Input / Output
CreateInsight
Command API Reference / Input / Output
CreateMembers
Command API Reference / Input / Output
DeclineInvitations
Command API Reference / Input / Output
DeleteActionTarget
Command API Reference / Input / Output
DeleteConfigurationPolicy
Command API Reference / Input / Output
DeleteFindingAggregator
Command API Reference / Input / Output
DeleteInsight
Command API Reference / Input / Output
DeleteInvitations
Command API Reference / Input / Output
DeleteMembers
Command API Reference / Input / Output
DescribeActionTargets
Command API Reference / Input / Output
DescribeHub
Command API Reference / Input / Output
DescribeOrganizationConfiguration
Command API Reference / Input / Output
DescribeProducts
Command API Reference / Input / Output
DescribeStandards
Command API Reference / Input / Output
DescribeStandardsControls
Command API Reference / Input / Output
DisableImportFindingsForProduct
Command API Reference / Input / Output
DisableOrganizationAdminAccount
Command API Reference / Input / Output
DisableSecurityHub
Command API Reference / Input / Output
DisassociateFromAdministratorAccount
Command API Reference / Input / Output
DisassociateFromMasterAccount
Command API Reference / Input / Output
DisassociateMembers
Command API Reference / Input / Output
EnableImportFindingsForProduct
Command API Reference / Input / Output
EnableOrganizationAdminAccount
Command API Reference / Input / Output
EnableSecurityHub
Command API Reference / Input / Output
GetAdministratorAccount
Command API Reference / Input / Output
GetConfigurationPolicy
Command API Reference / Input / Output
GetConfigurationPolicyAssociation
Command API Reference / Input / Output
GetEnabledStandards
Command API Reference / Input / Output
GetFindingAggregator
Command API Reference / Input / Output
GetFindingHistory
Command API Reference / Input / Output
GetFindings
Command API Reference / Input / Output
GetInsightResults
Command API Reference / Input / Output
GetInsights
Command API Reference / Input / Output
GetInvitationsCount
Command API Reference / Input / Output
GetMasterAccount
Command API Reference / Input / Output
GetMembers
Command API Reference / Input / Output
GetSecurityControlDefinition
Command API Reference / Input / Output
InviteMembers
Command API Reference / Input / Output
ListAutomationRules
Command API Reference / Input / Output
ListConfigurationPolicies
Command API Reference / Input / Output
ListConfigurationPolicyAssociations
Command API Reference / Input / Output
ListEnabledProductsForImport
Command API Reference / Input / Output
ListFindingAggregators
Command API Reference / Input / Output
ListInvitations
Command API Reference / Input / Output
ListMembers
Command API Reference / Input / Output
ListOrganizationAdminAccounts
Command API Reference / Input / Output
ListSecurityControlDefinitions
Command API Reference / Input / Output
ListStandardsControlAssociations
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
StartConfigurationPolicyAssociation
Command API Reference / Input / Output
StartConfigurationPolicyDisassociation
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateActionTarget
Command API Reference / Input / Output
UpdateConfigurationPolicy
Command API Reference / Input / Output
UpdateFindingAggregator
Command API Reference / Input / Output
UpdateFindings
Command API Reference / Input / Output
UpdateInsight
Command API Reference / Input / Output
UpdateOrganizationConfiguration
Command API Reference / Input / Output
UpdateSecurityControl
Command API Reference / Input / Output
UpdateSecurityHubConfiguration
Command API Reference / Input / Output
UpdateStandardsControl
Command API Reference / Input / Output